Skip to main content

dropboxListSharedLinks

Type

command

Summary

List shared links of this user.

Syntax

dropboxListSharedLinks <pAccessToken>, [<pPath>, <pDirectOnly>, <pCursor>, <pCallback>]

Description

If the callback parameter is not empty the request will be asynchronus and when complete the callback will be sent to the object that accessed the API. The callback will be sent with three parameters:

  • The request ID which will be the value of the it variable after calling the command
  • The HTTP response code
  • The data returned which will be the same data as documented for the it variable in a synchronous request.

Parameters

NameTypeDescription

pAccessToken

An OAuth2 Access token to access the user's account

pPath

If no path is given, returns a list of all shared links for the current user. If a non-empty path is given, returns a list of all shared links that allow access to the given path - direct links to the given path and links to parent folders of the given path.

pDirectOnly

Links to parent folders can be suppressed by setting direct_only to true.

pCursor

The cursor returned by your last call to list_shared_links. This field is optional.

pCallback

The handler to call when the request is complete. If empty the command will block until complete.